package cn.codepandas.unifiedresponse.model;

/**
 * 结果码接口类
 * <p>声明 http 状态码（status）、错误码（code）、错误信息（message）和用户提示信息（tip）的获取方法</p>
 *
 * @author Amaris
 * @since 1.0.2
 */
public interface IResultCode {

    /**
     * 获取 http 状态码
     * <p>面向浏览器，可使用范围为 100~103, 200~208, 226, 300~308, 400~451, 500~511</p>
     *
     * @return http 状态码
     */
    Integer getStatus();

    /**
     * 获取错误码
     * <p>面向前端人员，可使用范围为 除固有的 00000， A0001, B0001, C0001 外，根据错误类别，依次追加即可</p>
     *
     * @return 错误码
     */
    String getCode();

    /**
     * 获取错误信息
     * <p>面向排错人员</p>
     *
     * @return 错误信息
     */
    String getMessage();

    /**
     * 获取用户提示信息
     * <p>面向用户</p>
     *
     * @return 用户提示信息
     */
    String getTip();

}